home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / xstat140.zip / XFERSTAT.DOC < prev    next >
Text File  |  1992-08-07  |  11KB  |  340 lines
  1.  
  2.  
  3.                       ─┐╓ ╓── ╥─╖ ╥─╖ ╓─╖ ─╥─ ╓─╖ ─╥─ ╓─╖
  4.                       ╓┼╜ ╟─  ╟─  ╟┬╜ ╙─╖  ║  ╟─╢  ║  ╙─╖
  5.                       ╜└─ ╨   ╨─╜ ╨ \ ╙─╜  ╨  ╜ ╙  ╨  ╙─╜
  6.                       ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  7.                                   Release 1.40
  8.  
  9.                             Download Log Scanning and
  10.                         User's Statistics Door For PCB14.x
  11.                                 by: Keith Cochran
  12.                         SysOp, Paradox BBS (302) 645-7264
  13.  
  14.                      Entire Work, Including Documention is
  15.                    Copyrighted by Keith N. Cochran. (c) 1992
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.     What is XferStats ?
  61.     -------------------
  62.  
  63.     XferStats was born out a need for a small utility to allow users 
  64.     and the SysOp to scan PCBoard's DOWNLOAD.TXT file for a listing of
  65.     files they have transferred.  Sam Smith's ProWho door allowed this, 
  66.     but many users did not like the idea that other users could do a 
  67.     scan on THEIR name too.  This is especially true if your BBS contains
  68.     adult or other "sensitive" type files.
  69.      
  70.     About a month ago, I came across just such a door program.  But it 
  71.     was so severely crippled and poorly written that I was embarrassed
  72.     to even put it up publicly.  So I said "what the hell, I'll write my
  73.     own version".  So please keep in mind that this is my first attempt
  74.     at writting a full blown door program.
  75.  
  76.     I'd like to take this oppurtunity to thank Sam Smith for his wonderful
  77.     ProKit libraries, without which; many, many door programs would have 
  78.     never been written.
  79.  
  80.  
  81.  
  82.     Features
  83.     --------
  84.  
  85.     Simple to setup.  Zero maintenance.
  86.  
  87.     Support for both PCBoard & ProDoor BBS types. (Some features require
  88.     PCBoard 14.5+)
  89.  
  90.     Maybe be run as a PCBoard "SHELL" door.  XferStats is 100% seamless
  91.     when registered and run in SHELL mode.  Filename to get File Stats
  92.     for may be passed from PCBoard 14.5's command line.
  93.  
  94.     Allows a caller to list what files he/she has transferred to/from
  95.     the BBS with a nicely formatted, colorized display.
  96.  
  97.     Allows a caller to create a list of what files he/she has transferred 
  98.     to/from the BBS, that they can then download.
  99.  
  100.     Allows the caller to view his/her's personal statistics.
  101.  
  102.     Allows the caller to find out when a file was uploaded, how many
  103.     times it has been downloaded, and when it was last downloaded. 
  104.     If the caller has SysOp security, he/she will also be shown who
  105.     uploaded the file.
  106.  
  107.  
  108.  
  109.     Files associated with the door's operation:
  110.     -------------------------------------------
  111.  
  112.        XFERSTAT.EXE : The main program.
  113.        XFERSTAT.DOC : You're looking at it.
  114.        XFERSTAT.CNF : The configuration file (explained below).
  115.        XF.CNF       : Alternate configuration file (SHELL Mode)
  116.        XFERSTAT.DAT : The protocol translation file (explained below).
  117.        XFERSTAT.HST : History of changes made.
  118.        XFERSTAT.HLP : Help file.
  119.        XFERSTAT     : Sample Door batch file
  120.        XF           : Sample Door batch file (SHELL Mode)
  121.        XFMENU       : User Menu.
  122.        XFMENUS      : SysOp's menu.
  123.        XCLOSE       : Closing file displayed when run in Non-Shell mode. (Opt)
  124.  
  125.  
  126.     Setup:
  127.     ------
  128.  
  129.     UnZip the contents of the zip file into a directory of your choosing.
  130.     Edit the XFERSTAT.CNF & XFERSTAT.DAT files as outlined below.
  131.  
  132.     >>>>>  In order for the List & D/L functions to operate, both  <<<<<
  133.     >>>>>    PKZIP.EXE & DSZ.COM must be available via the PATH.   <<<<<
  134.  
  135.     ****  N O T E :  The Create List and D/L Functions Are DISABLED  ****
  136.     ****             When Running In The PCBoard SHELL Mode !!!!!    ****
  137.  
  138.  
  139.     The XFERSTAT.CFG file:
  140.     ----------------------
  141.  
  142.     INTERRUPT
  143.     C:\PCB\MAIN\DOWNLOAD.TXT
  144.     XCLOSE
  145.     BBS NAME
  146.     0
  147.     120
  148.     YES
  149.     YES
  150.  
  151.     Line 1.  Interface type.  Standard for ProKit.
  152.     Line 2.  Path AND Name of DOWNLOAD.TXT file.
  153.     Line 3.  Optional Closing file. (Not displayed in SHELL mode)
  154.     Line 4.  BBS name (Displayed in registered versions only)
  155.     Line 5.  Registration # (0 if unregistered)
  156.     Line 6.  Minimum security level to use SysOp functions.
  157.     Line 7.  Whether Door is being run as a SHELL program. YES/NO
  158.              This is important, as it's disables the Create List function
  159.              do to memory constraints when operating as a SHELL door.
  160.              It also disables the display of the closing message and
  161.              the closing file when in SHELL mode for a truly seamless
  162.              look.  (When registered).
  163.     LINE 8.  Whether entries should be written to the CALLERx file. YES/NO
  164.              These include what the caller scanned for, if they downloaded
  165.              a list, etc. 
  166.  
  167.  
  168.     The XFERSTAT.DAT file:
  169.     ----------------------
  170.  
  171.     This file simply contains the protocol letter used by PCB and a name
  172.     that you wish the letter to be tranlated to when displayed.
  173.  
  174.     This file is optional, but is HIGHLY RECOMMENDED.
  175.  
  176.     A sample XFERSTAT.DAT is included in the ZipFile.  It may contain 
  177.     up to 19 translations (2 lines each).  Each translation to be used 
  178.     may contain up to 7 letters.  The format is as follows:
  179.  
  180. Z
  181. Zmodem
  182. Y
  183. Ymodem
  184. G
  185. YmodemG
  186. H
  187. HS/Link
  188. M
  189. MPT
  190. N
  191. None
  192. ...
  193. etc...
  194.  
  195.  
  196.     Door Batch File:
  197.     ----------------
  198.  
  199.     I won't spend a lot of times on how to set up a door with PCBoard.
  200.     If in doubt, I suggest you read PCBoard's manual.  XFERSTAT is called
  201.     like any other ProKit door.  
  202.  
  203.     Sample door batch file:
  204.  
  205.     @echo off
  206.     cd \pcb\doors\xferstat
  207.     xferstat xferstat.cnf c:\pcb\pcboard.sys
  208.     cd \pcb
  209.     board  <== Omit this line if you are running it as a SHELL door.
  210.  
  211. ************************  S P E C I A L   N O T E  **************************
  212.  
  213.     XferStats has the unique ability to be run in TWO totally separate modes
  214.     of operation.  The "normal" DOOR mode, and as a PCB14.5 "SHELL" DOOR.
  215.  
  216.     On my BBS, I offer it both ways.  As a normal door from the door menu,
  217.     and as a SHELL door, which can be listed as a menu command on PCB's
  218.     Main Menu.
  219.  
  220.     This requires using TWO separate DOOR batch files (see XFERSTAT & XF)
  221.     and TWO separate .CNF files (see XFERSTAT.CNF and XF.CNF).
  222.  
  223.     Make TWO entires in your DOORS.LST file as follows:
  224.  
  225. XFERSTAT,,31,0,0,,0,N  <===  This is "normal" DOOR.
  226.  
  227. XF,,31,0,0,,0,Y        <===  This is "SHELL" DOOR.
  228.  
  229. ***************************************************************************
  230.  
  231.     Using XFERSTAT:
  232.     ---------------
  233.  
  234.     The user has several choices from the Main Menu:
  235.  
  236.     D - List all files downloaded and contained in DOWNLOAD.TXT
  237.  
  238.     U - List all files uploaded and contained in DOWNLOAD.TXT
  239.  
  240.     A - List all files (both D & U) tranferred and contained in DOWNLOAD.TXT
  241.  
  242.     C - Create a list of All files transferred and D/L the list. 
  243.         (Not available when running in SHELL mode !!!)
  244.  
  245.     Y - List their personal statistics.
  246.  
  247.     F - File Stats.  See the stats on a particuliar file.
  248.  
  249.  
  250.     If the caller's security matches or is greater than the level listed
  251.     in the XFERSTAT.CNF file, they will also have available the S option.
  252.  
  253.     Selecting this will allow searching for a text match in either the
  254.     USER or FILENAME fields.
  255.  
  256.  
  257.     If you are running XferStats in SHELL mode, you may enter a filename
  258.     to see the stats on right from PCBoard's command line.
  259.  
  260.     I would suggest that you name the door batch file to something
  261.     like XF if you plan to run XferStats in seamless mode.
  262.  
  263.     Then the caller can just type " XF anyfile.zip " and they will go
  264.     directly into File Stats Mode.
  265.  
  266.     Registration:
  267.     -------------
  268.  
  269.     XFERSTAT is released as ShareWare and may be used freely for a period
  270.     not to exceed 90 days.  After the 90 day period, you must either discon-
  271.     tinue using the software or register it.  The shareware version is fully 
  272.     functional, with the exception of the [UNREGISTERED] messages and the 
  273.     delay upon exiting the door.
  274.  
  275.     If you like the program, and wish to register it, send $15.00 (US) in
  276.     the form of Check or Money Order to the address provided below:
  277.  
  278.     Keith Cochran
  279.     P.O. Box 950
  280.     Rehoboth Beach, DE
  281.     19971
  282.     U.S.A.
  283.    
  284.     You will then be issued a registration number that will display your
  285.     BBS name on the opening and closing screens and will disable the delay
  286.     when exiting the door.
  287.  
  288.     The registration number will work with ALL future releases of XFERSTAT.
  289.  
  290.     Be sure to include a return address and specify EXACTLY how you will
  291.     spell your BBS name in the .CNF file.
  292.                ^^^
  293.  
  294.     Disclaimer:
  295.     -----------
  296.  
  297.     I make no warranty of any kind, express or implied, including without
  298.     limitation, any warranties of merchantability and/or fitness for a
  299.     particular purpose.  I shall not be liable for any damages, whether
  300.     direct, indirect, special or consequential arising from a failure of
  301.     this program to operate in the manner desired by the user.  I shall not
  302.     be liable for any damage to data or property which may be caused
  303.     directly or indirectly by the use of this program.
  304.  
  305.     IN NO EVENT WILL I BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST
  306.     PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES
  307.     ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM, OR FOR ANY
  308.     CLAIM BY ANY OTHER PARTY.
  309.  
  310.     PCBoard is a registered trademark of Clark Development Company.
  311.     InstaReg is copyrighted by Don Cheeks and Lana Fox.
  312.     Turbo Pascal 6.0 is copyrighted by Borland International.
  313.  
  314.  
  315.     Beta Testers:
  316.     -------------
  317.  
  318.     Special thanks to the following people who were a great help 
  319.     with testing XferStats.
  320.  
  321.     Butch Dunn       The No*Name BBS    (302) 477-1230 HST 14.4K 
  322.     Greg Parsons     Paradise Cove BBS  (302) 436-4780 HST 14.4K
  323.  
  324.     Be sure to check out these 2 bbs's, as both are first class systems.
  325.  
  326.     Support:
  327.     --------
  328.  
  329.     The latest version of XferStats can always be found on Paradox BBS. 
  330.     The numbers are (302) 645-7264 & 645-2658.  Additional time/privileges 
  331.     for visiting SysOps.  Node 1 is equipped with a USR Dual Standard.
  332.  
  333.     I also may be reached via SaltAir's DOORS conference,  via RIME's 
  334.     DOORS, SYSOPS or COMMON conferences, ILink's SYSOPS conference, 
  335.     MetroLink's SYSOPS conference.   Node ID for RIME and MetroLink 
  336.     is ->PARADOX
  337.  
  338.     Comments, ideas, or suggestions are always welcome.
  339.  
  340.